home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / olrdrs / qprn112.zip / QWKPRUNE.DOC < prev    next >
Text File  |  1994-05-12  |  27KB  |  591 lines
  1.                                QWKPRUNE  1.12
  2.                                    -----
  3.   A utility to remove unwanted messages from QWK-format mail packets.
  4.  
  5.   QWKPRUNE.EXE, KILLMSG.EXE, ZIPPYZAP.EXE, this documentation, and all
  6.   associated documentation are Copyright (c) 1992-1994.  SAVEQWK.EXE and
  7.   MKPRN.EXE, are Copyright (c) 1992, 1993.  KMSG-D2.EXE and VIDGRAB.EXE
  8.   are Copyright (c) 1993, 1994.  FILGRAB.EXE is Copyright (c) 1994 by David
  9.   Harden.  All rights reserved.
  10.  
  11.   PARM.EXE is hereby released into the public domain.
  12.  
  13.   The code used to qualify filenames is based on QFN.C by Ray Duncan.
  14.   The original code was published in Vol. 7, No. 14 of PC Magazine, and is
  15.   copyrighted by Ziff-Davis.
  16.  
  17.   Autodetection of LHA and ZOO files is based on information from GUS
  18.   (General Unpack Shell) version 1.70, by Johan Zwiekhorst.  
  19.   
  20.   All brand or product names mentioned in this documentation or any
  21.   associated files are trademarks or registered trademarks of their
  22.   respective owners.  All products mentioned are copyrighted by their
  23.   respective owners.  My use of these trademarks does not imply that their
  24.   owners have endorsed QWKPRUNE, nor does it imply that I have endorsed
  25.   their products.
  26.  
  27.   QWKPRUNE should not be confused with QWKMerge, which is a trademark and
  28.   copyrighted product of Mike King.  QWKPRUNE and David Harden are not
  29.   affiliated with Mike King.
  30.  
  31.   See LICENSE.DOC for license and registration information.
  32.  
  33.  
  34.                           Disclaimer of Liability
  35.                                    -----
  36.   There is no warranty of any kind, either express or implied, covering
  37.   this software or any associated materials.  This software and all
  38.   associated materials are provided as is, use them at your own risk.
  39.   The copyright holder is in no way responsible or liable for any losses or
  40.   damages of any kind that may result from the use of this software or any
  41.   associated materials, or from inability to use them.
  42.  
  43.  
  44.                             System requirements
  45.  
  46.   DOS 3.x or higher is preferred.  I see no reason why this program
  47.   shouldn't work with DOS 2.x, but this hasn't been tested.
  48.  
  49.   How much memory is required depends on how many messages are to be
  50.   processed.  Approximately 211K free RAM is needed to process 400
  51.   messages.  If either the /T or /TQ command line switches are used, this
  52.   drops to 147K, as the 64K write buffer won't be allocated.
  53.  
  54.   QWKPRUNE will attempt to allocate enough memory to store data from all
  55.   the message headers.  400 messages require 42K of RAM for storage.  If
  56.   there's not enough memory to store all the header data, and an overflow
  57.   directory has been defined, QWKPRUNE will store the data in that
  58.   directory.  In this case, there must be enough free RAM to store the
  59.   header data from all the messages in the largest conference.
  60.  
  61.  
  62.                               What does it do?
  63.                                    -----
  64.   Removes unwanted messages from QWK-format mail packets based on the
  65.   contents of their message headers.  The modified packet can either be
  66.   repacked or fed into a mail reader or other QWK utility.  See READER.DOC
  67.   for more details.
  68.  
  69.   An "unkill" option allows flexibility in deciding which messages are
  70.   pruned out.
  71.  
  72.   Removes (R) and Re: prefixes, as well as leading whitespace, from
  73.   the subject field of messages.  Up to ten additional user-defined
  74.   prefixes can also be stripped from subject lines.
  75.   
  76.   Can tag messages for processing by programs such as KingQWK and QWKMerge.
  77.  
  78.   Transparently repairs conference numbers in packets from older doors that
  79.   pad the conference number with a space.  Repairs "garbage" conference
  80.   numbers in packets from Virtual QWK.
  81.  
  82.   Fixes null-terminated string fields in message headers.  Also fixes
  83.   headers in which the To: and From: fields are terminated with linefeed
  84.   characters.
  85.  
  86.   "Untrashes" QWK packets altered by EZ-RDR.
  87.  
  88.  
  89.                              How to install it
  90.                                    -----
  91.   Place QWKPRUNE.EXE in a directory on your DOS path.  Use your editor
  92.   to create the needed control files (see below).  That's all.
  93.  
  94.  
  95.                                    Files
  96.                                    -----
  97.   QWKPRUNE's configuration and prune files are ASCII text files that may be
  98.   created and modified by any text editor, or by a word processor in
  99.   nondocument mode.  Lines may be up to 99 characters long, but usually
  100.   shouldn't need to be that long.  Any line that begins with a semicolon
  101.   will be treated as a comment, and its contents will be ignored.  
  102.  
  103.  
  104.                            The configuration file
  105.                                    -----
  106.   The configuration file is named QWKPRUNE.CFG, and is located in the same
  107.   directory as QWKPRUNE.EXE.  A configuration file may look something like
  108.   this:
  109.  
  110.   ZIP = pkzip
  111.   UNZIP = pkunzip
  112.   LHA = lha a /m
  113.   UNLHA = lha e
  114.   ARJ = arj a -e
  115.   UNARJ = arj e
  116.   ZOO = zoo -add %q *
  117.   UNZOO = zoo -extract %q *
  118.   USER_PACK = pkpak -a
  119.   USER_UNPACK = pkunpak
  120.   QWK = c:\download\qwk
  121.   WORK = c:\
  122.   PRUNE = c:\prune
  123.   GLOBAL = global.prn
  124.   STRIP = Re :, Re(2):, Re ,
  125.   SPILL = d:\
  126.   MAX_QWK_AGE = 0
  127.   FORCE_REPACK = ON
  128.   USE_MESSAGE_COUNTS = OFF
  129.   KEEP_NETSTATUS = OFF
  130.  
  131.   QWKPRUNE will automatically detect ZIP, LHA, ARJ, and ZOO files.
  132.   USER_PACK and USER_UNPACK are commands to pack and unpack files
  133.   compressed with another archiver.  In these entries, %q may be used as a
  134.   substitute for the QWK file name.  If %q isn't used, QWKPRUNE assumes
  135.   that the QWK file name is at the end of the command.
  136.  
  137.   QWK is the directory where you want QWKPRUNE to look for QWK files.  WORK
  138.   is the directory where QWKPRUNE will create its work directory.  A
  139.   directory named QP$WORK will be created under this directory.  PRUNE is
  140.   the default directory where prune files are located.  GLOBAL is the name
  141.   of a global prune file, which will be used for all QWK packets.  If
  142.   GLOBAL is not specified, a global prune file will not be used.  (See the
  143.   section on prune files for more details on this file.)
  144.  
  145.   SPILL is the directory where QWKPRUNE will create its overflow directory.
  146.   If necessary, a directory named QP$SPILL will be created under this
  147.   directory.  If there's not enough space in the work directory to rebuild
  148.   MESSAGES.DAT, it will be rebuilt there.  The new MESSAGES.DAT will then
  149.   copied to the work directory.  If there's not enough free RAM to store
  150.   the data from all the message headers, QWKPRUNE will store this data
  151.   data in the QP$SPILL directory.  If SPILL hasn't been set in the config
  152.   file, or if it's set to a nonexistent directory, QWKPRUNE will read the
  153.   TEMP environment variable.
  154.  
  155.   STRIP is the list of prefixes, other than (R) and Re:, that you want to
  156.   strip from subject lines.  Up to ten prefixes may be specified, and
  157.   individual prefixes may be up to twelve characters long.  Prefixes may
  158.   have trailing spaces.  The list may end with a comma, but doesn't have to
  159.   unless the last prefix has trailing spaces.  Case is not significant.
  160.  
  161.   If FORCE_REPACK is set to either ON or YES, QWKPRUNE will always repack
  162.   QWKs, even if they haven't been changed.
  163.  
  164.   If MAX_QWK_AGE is set to a number, QWKs more than that many days old
  165.   won't be processed if wildcards are used in the QWK file name or the
  166.   default (*.Q*) is used.  For example, MAX_QWK_AGE = 0 limits processing
  167.   to packets with the current date.
  168.  
  169.   If USE_MESSAGE_COUNTS is set to ON or YES, message counts will be added
  170.   to MESSAGES.DAT and CONTROL.DAT if MESSAGES.DAT is rebuilt.  If it's set
  171.   to OFF or NO, and a message count is in CONTROL.DAT, that count will be
  172.   set to zero if MESSAGES.DAT is rebuilt.
  173.  
  174.   If KEEP_NETSTATUS is set to OFF or NO, Net Status blocks at the end of
  175.   MESSAGES.DAT will be discarded if MESSAGES.DAT is rebuilt.  The default
  176.   is to keep Net Status blocks.  QWKPRUNE preserves Net Status blocks by
  177.   copying everything past the end of the last indexed message to the new
  178.   MESSAGES.DAT file.  If some .NDX f